@W-18706176: Changes to download latest release version of the API by unandyala · Pull Request #231 · SalesforceCommerceCloud/raml-toolkit

unandyala · 2025-06-04T21:27:40Z

@W-18706176 @W-18763414

Get latest version form all the version groups (V1, V2) of an API. This is to suuport Shopper Baskets V1 and V2
Remove the deprecated deployment flag
Added tests exchangeDirectoryParser to meet the coverage threshold
Spilt the test for exchangeDownloader.ts as there is a warning on the file size
All the code is behind isOas flag

Testing

download command
node bin/run download --dest=raml-test --search='category:Visibility = "External"' --log-level=debug
ran updateApis script in commerce-isomorphic-sdk

vcua-mobify · 2025-06-05T17:47:16Z

Thanks for this @unandyala . The changes have ensured that I download the latest stable oas specs.

I wonder if we want to have a toggle where we can disable the check? Just wondering if pulling a snapshot spec for testing purposes is a valid use case we have to account for.

unandyala · 2025-06-06T15:46:30Z

Thanks for this @unandyala . The changes have ensured that I download the latest stable oas specs.

I wonder if we want to have a toggle where we can disable the check? Just wondering if pulling a snapshot spec for testing purposes is a valid use case we have to account for.

I don't think we need other versions. There will be lot of them and they are mainly developer versions. They may not even have backend implementation

joeluong-sfcc

This is a breaking change correct? Other than the minor comments, this PR LGTM, but could you update the CHANGELOG for this change?

joeluong-sfcc · 2025-06-09T18:30:34Z

src/download/exchangeDownloader.test.ts

-      asset.id = "893f605e-10e2-423a-bdb4-f952f56eb6d8/shopper-customers/0.5.0";
-      asset.version = "0.5.0";
-      asset.fatRaml.externalLink = "https://somewhere/fatraml.zip";
+    it("searches Exchange and returns multiple version groupd", () => {


Suggested change

it("searches Exchange and returns multiple version groupd", () => {

it("searches Exchange and returns multiple version groups", () => {

joeluong-sfcc · 2025-06-09T19:18:47Z

src/download/exchangeDownloader.ts

+    return releaseSemverRegex.test(version.version);
+  });
+  // Sort versions and get the latest
+  return releaseAssetVersions.sort((instanceA, instanceB) => {


This function is a nice solution, it feels like a very clean way to get the latest version, straightforward to understand

joeluong-sfcc · 2025-06-09T19:23:14Z

src/download/exchangeDownloader.ts

-    ramlToolLogger.warn(DEPLOYMENT_DEPRECATION_WARNING);
-  }
-
+export async function search(query: string): Promise<RestApi[]> {


We're planning to search based on the API SDK Type and Visibility categories/types correct? Previously we queried by name... How does it look now when we call search function in the SDKs?

For node sdk, it will be
await download.search( 'category:Visibility = "External" category:"SDK Type" = "Commerce"' );

For isomorphic sdk, it will be
await download.search( 'category:Visibility = "External" category:"SDK Type" = "Commerce"' category:"SDK Type" = "Isomorphic"' );

joeluong-sfcc · 2025-06-09T19:31:51Z

src/download/exchangeDownloader.ts

 * @returns {Promise<string>} Returned the version string from the instance fetched asset.version value
 */
-export async function getVersionByDeployment(
+export async function getApiVersions(


It's not clear in the description or the function name that we get the latest version, we should rename this function to something like getLatestApiVersions and/or update the JS doc description

Since getApiVersions is a new function, can we keep the old getVersionByDeployment still?
Would keeping getVersionByDeployment make this a non-breaking change?

Does raml-toolkit have other users aside from commerce-sdk / commerce-sdk-isomorphic? This change would break those, if they exists.

Also, if we're going to be making a breaking change here, are there other breaking changes we also want to get in?

We marked deployment flag as deprecated a while back. So I think it is ok to change the function name.
The raml-toolkit is only used by commerce-sdk / commerce-sdk-isomorphic

Refactored to put all the new code behind isOas flag

joeluong-sfcc · 2025-06-09T19:33:48Z

src/download/exchangeDownloader.ts

+
+  return Promise.all(promises).then((results) =>
+    results.reduce((acc, val) => acc.concat(val), [])
+  );


This isn't immediately clear to me what this does, could you add a small comment?

vcua-mobify

Thanks for refactoring this PR to be a non-breaking change! Good idea to use the isOas to feature flag all of the changes.

LGTM

vcua-mobify · 2025-06-11T00:41:34Z

src/download/exchangeDirectoryParser.test.ts

  chai.use(chaiAsPromised);
 });

+describe("extractFile", () => {


Thanks for adding this. From the looks of it, we were only testing extractFiles before and not extractFile.

vcua-mobify · 2025-06-11T00:53:07Z

src/download/exchangeDownloader.ts

+    ramlToolLogger.error(
+      `${logPrefix} The rest API ${restApi.assetId} is missing asset.versionGroups`
+    );
+    return;


Probably a good idea to give the API team a heads up about this since I don't know if everything defines a versionGroup.

joeluong-sfcc

LGTM, only thing has the CI always failed since we added OAS support in RAML toolkit, or did it start with this PR? Either way we should resolve the CI so that tests pass

unandyala · 2025-06-11T19:39:12Z

LGTM, only thing has the CI always failed since we added OAS support in RAML toolkit, or did it start with this PR? Either way we should resolve the CI so that tests pass

this is an existing issue not related to the PR - /bin/sh: 1: oasdiff: not found
Error: oasdiff is not installed. Install oasdiff according to https://github.com/oasdiff/oasdiff#installation

vcua-mobify

Thanks for fixing the CI issue @unandyala

Changes to download latest release version of the API

fc05fd7

unandyala added 2 commits June 5, 2025 18:31

Download multiple versions

3be05c7

Download multiple version groups

124facb

unandyala changed the title ~~WIP: Changes to download latest release version of the API~~ @W-18706176: Changes to download latest release version of the API Jun 6, 2025

unandyala marked this pull request as ready for review June 6, 2025 18:01

unandyala requested a review from a team as a code owner June 6, 2025 18:01

unandyala requested review from joeluong-sfcc and vcua-mobify June 6, 2025 18:02

Merge branch 'main' into unandyala.download-latest-release-spec

4eb84b2

joeluong-sfcc reviewed Jun 9, 2025

View reviewed changes

vcua-mobify mentioned this pull request Jun 9, 2025

@W-18575180@ Generate node SDK from OAS SalesforceCommerceCloud/commerce-sdk#418

Merged

unandyala added 3 commits June 9, 2025 19:54

minor refactor

cf39219

refactor to use oas flag

1ae9e37

update copyright year

e054bae

vcua-mobify previously approved these changes Jun 11, 2025

View reviewed changes

joeluong-sfcc previously approved these changes Jun 11, 2025

View reviewed changes

fix CI issue

18916b8

unandyala dismissed stale reviews from joeluong-sfcc and vcua-mobify via 18916b8 June 11, 2025 20:10

unandyala added 7 commits June 11, 2025 16:13

fix CI issue

8b8328d

fix CI issue

a66adba

fix CI issue

3594351

fix CI issue

2e53367

fix CI issue

db20d1c

fix CI issue

f04ea42

fix CI issue

190bb3d

vcua-mobify approved these changes Jun 11, 2025

View reviewed changes

joeluong-sfcc approved these changes Jun 11, 2025

View reviewed changes

unandyala merged commit fc946fc into main Jun 12, 2025
7 checks passed

unandyala deleted the unandyala.download-latest-release-spec branch June 12, 2025 00:18

	it("searches Exchange and returns multiple version groupd", () => {
	it("searches Exchange and returns multiple version groups", () => {

Conversation

unandyala commented Jun 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vcua-mobify commented Jun 5, 2025

Uh oh!

unandyala commented Jun 6, 2025

Uh oh!

joeluong-sfcc left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vcua-mobify Jun 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vcua-mobify left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

joeluong-sfcc left a comment

Choose a reason for hiding this comment

Uh oh!

unandyala commented Jun 11, 2025

Uh oh!

vcua-mobify left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

unandyala commented Jun 4, 2025 •

edited

Loading

vcua-mobify Jun 9, 2025 •

edited

Loading